API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

products

Retrieves a products resource.

Retrieves a products resource.

Authorizations:
JWT
path Parameters
id
required
string

products identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "sku": "string",
  • "version": "string",
  • "price": "string",
  • "priceSpecial": "string",
  • "visibleStatus": true,
  • "taxable": true,
  • "country": "string",
  • "place": "string",
  • "placePrecision": "string",
  • "producible": true,
  • "newStatus": true,
  • "type": {
    },
  • "brand": {
    },
  • "supplier": {
    },
  • "weight": "string",
  • "dimensionW": "string",
  • "dimensionH": "string",
  • "dimensionD": "string",
  • "time": "string",
  • "cost": "string",
  • "additionnalProductionCost": "string",
  • "costSpecial": "string",
  • "invQtyMin": "string",
  • "invQtyMax": "string",
  • "moq": "string",
  • "packageOrder": "string",
  • "inventoryTracking": true,
  • "rentTracking": true,
  • "countedInInventory": true,
  • "shippingTracking": true,
  • "notes": "string",
  • "notesInvoice": "string",
  • "notesBill": "string",
  • "notesRent": "string",
  • "notesProduction": "string",
  • "notesInventory": "string",
  • "notesShipping": "string",
  • "unitType": {
    },
  • "unitNb": 1,
  • "supplierCode": "string",
  • "clientCode": "string",
  • "shCode": "string",
  • "reservationPeriodicity": {
    },
  • "periodicityPrecision": "string",
  • "bookable": true,
  • "discountable": true,
  • "salable": true,
  • "invoiceLineType": {
    },
  • "purchasable": true,
  • "billLineType": {
    },
  • "onDistribution": true,
  • "onWebsite": true,
  • "owningCorporation": {
    },
  • "isVariableExpense": true,
  • "isImmo": true,
  • "isConsumable": true,
  • "shortcode": "A",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "billLinesListing": "string",
  • "customPropertiesListing": "string",
  • "invoiceLinesListing": "string",
  • "rentsListing": "string",
  • "rentsChargedListing": "string",
  • "inventoryEntriesListing": "string",
  • "applicableCost": 0,
  • "translationTitlePropertyName": "string",
  • "applicablePrice": 0,
  • "inStock": 0,
  • "productStockProgressBar": 0,
  • "productStockRatio": 0,
  • "productStockPercentage": 0,
  • "correction": 0,
  • "lastInventoryEntry": "2019-08-24T14:15:22Z",
  • "productOptionsListing": "string",
  • "subProductOptionsListing": "string",
  • "productComponentsListing": "string",
  • "componentProductsListing": "string",
  • "translationsListing": "string",
  • "buyableBasePrice": 0,
  • "discount": 0,
  • "maxProductionCapacity": 0,
  • "applicableSupplierCode": "string",
  • "applicableClientCode": "string",
  • "consumable": true,
  • "translationDescriptionPropertyName": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the products resource.

Replaces the products resource.

Authorizations:
JWT
path Parameters
id
required
string

products identifier

Request Body schema:
required

The updated products resource

name
string
description
string
Array of objects (project_sectors.jsonld-post)
sku
string or null
version
string or null
price
required
string
priceSpecial
required
string
visibleStatus
required
boolean
Default: true
taxable
required
boolean
Default: true
country
string or null
place
string or null <= 255 characters
placePrecision
string or null <= 255 characters
producible
required
boolean
Default: true
newStatus
required
boolean
Default: true
required
object (product_types.jsonld-post)

Type.

product_brands.jsonld-post (object) or null
person_suppliers.jsonld-post (object) or null
weight
required
string
dimensionW
required
string
dimensionH
required
string
dimensionD
required
string
time
string

Assert\NotNull( message = "product.time.notNull" )

cost
required
string
additionnalProductionCost
required
string
costSpecial
required
string
invQtyMin
required
string
invQtyMax
required
string
moq
required
string
packageOrder
required
string
inventoryTracking
required
boolean
rentTracking
required
boolean
countedInInventory
required
boolean
shippingTracking
required
boolean
notes
string or null
notesInvoice
string or null
notesBill
string or null
notesRent
string or null
notesProduction
string or null
notesInventory
string or null
notesShipping
string or null
Array of objects (product_product_options.jsonld-post)
Array of objects (product_productbuycosts.jsonld-post)
Array of objects (product_productsellprices.jsonld-post)
object (product_unit_types.jsonld-post)

UnitType.

unitNb
string
Default: 1
supplierCode
string or null
clientCode
string or null
shCode
string or null
parameter_periods.jsonld-post (object) or null
periodicityPrecision
required
string
bookable
required
boolean
Default: true
discountable
required
boolean
Default: true
salable
required
boolean
Default: true
object (invoice_line_types.jsonld-post)

LinesTypes.

purchasable
required
boolean
Default: true
object (bill_line_types.jsonld-post)

Bill Line Types.

onDistribution
required
boolean
Default: true
onWebsite
required
boolean
Default: true
isVariableExpense
required
boolean
Default: true
isImmo
required
boolean
isConsumable
required
boolean
Default: true
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>
apiTranslations
Array of strings

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "sectors": [
    ],
  • "sku": "string",
  • "version": "string",
  • "price": "string",
  • "priceSpecial": "string",
  • "visibleStatus": true,
  • "taxable": true,
  • "country": "string",
  • "place": "string",
  • "placePrecision": "string",
  • "producible": true,
  • "newStatus": true,
  • "type": {
    },
  • "brand": {
    },
  • "supplier": {
    },
  • "weight": "string",
  • "dimensionW": "string",
  • "dimensionH": "string",
  • "dimensionD": "string",
  • "time": "string",
  • "cost": "string",
  • "additionnalProductionCost": "string",
  • "costSpecial": "string",
  • "invQtyMin": "string",
  • "invQtyMax": "string",
  • "moq": "string",
  • "packageOrder": "string",
  • "inventoryTracking": true,
  • "rentTracking": true,
  • "countedInInventory": true,
  • "shippingTracking": true,
  • "notes": "string",
  • "notesInvoice": "string",
  • "notesBill": "string",
  • "notesRent": "string",
  • "notesProduction": "string",
  • "notesInventory": "string",
  • "notesShipping": "string",
  • "productOptions": [
    ],
  • "productBuyCosts": [
    ],
  • "productSellPrices": [
    ],
  • "unitType": {
    },
  • "unitNb": 1,
  • "supplierCode": "string",
  • "clientCode": "string",
  • "shCode": "string",
  • "reservationPeriodicity": {
    },
  • "periodicityPrecision": "string",
  • "bookable": true,
  • "discountable": true,
  • "salable": true,
  • "invoiceLineType": {
    },
  • "purchasable": true,
  • "billLineType": {
    },
  • "onDistribution": true,
  • "onWebsite": true,
  • "isVariableExpense": true,
  • "isImmo": true,
  • "isConsumable": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "apiTranslations": [
    ]
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "sku": "string",
  • "version": "string",
  • "price": "string",
  • "priceSpecial": "string",
  • "visibleStatus": true,
  • "taxable": true,
  • "country": "string",
  • "place": "string",
  • "placePrecision": "string",
  • "producible": true,
  • "newStatus": true,
  • "type": {
    },
  • "brand": {
    },
  • "supplier": {
    },
  • "weight": "string",
  • "dimensionW": "string",
  • "dimensionH": "string",
  • "dimensionD": "string",
  • "time": "string",
  • "cost": "string",
  • "additionnalProductionCost": "string",
  • "costSpecial": "string",
  • "invQtyMin": "string",
  • "invQtyMax": "string",
  • "moq": "string",
  • "packageOrder": "string",
  • "inventoryTracking": true,
  • "rentTracking": true,
  • "countedInInventory": true,
  • "shippingTracking": true,
  • "notes": "string",
  • "notesInvoice": "string",
  • "notesBill": "string",
  • "notesRent": "string",
  • "notesProduction": "string",
  • "notesInventory": "string",
  • "notesShipping": "string",
  • "unitType": {
    },
  • "unitNb": 1,
  • "supplierCode": "string",
  • "clientCode": "string",
  • "shCode": "string",
  • "reservationPeriodicity": {
    },
  • "periodicityPrecision": "string",
  • "bookable": true,
  • "discountable": true,
  • "salable": true,
  • "invoiceLineType": {
    },
  • "purchasable": true,
  • "billLineType": {
    },
  • "onDistribution": true,
  • "onWebsite": true,
  • "owningCorporation": {
    },
  • "isVariableExpense": true,
  • "isImmo": true,
  • "isConsumable": true,
  • "shortcode": "A",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "billLinesListing": "string",
  • "customPropertiesListing": "string",
  • "invoiceLinesListing": "string",
  • "rentsListing": "string",
  • "rentsChargedListing": "string",
  • "inventoryEntriesListing": "string",
  • "applicableCost": 0,
  • "translationTitlePropertyName": "string",
  • "applicablePrice": 0,
  • "inStock": 0,
  • "productStockProgressBar": 0,
  • "productStockRatio": 0,
  • "productStockPercentage": 0,
  • "correction": 0,
  • "lastInventoryEntry": "2019-08-24T14:15:22Z",
  • "productOptionsListing": "string",
  • "subProductOptionsListing": "string",
  • "productComponentsListing": "string",
  • "componentProductsListing": "string",
  • "translationsListing": "string",
  • "buyableBasePrice": 0,
  • "discount": 0,
  • "maxProductionCapacity": 0,
  • "applicableSupplierCode": "string",
  • "applicableClientCode": "string",
  • "consumable": true,
  • "translationDescriptionPropertyName": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the products resource.

Removes the products resource.

Authorizations:
JWT
path Parameters
id
required
string

products identifier

Responses